FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/artifact-description

Packagehl7.fhir.uv.extensions
Resource TypeStructureDefinition
Idartifact-description
FHIR VersionR5
Sourcehttp://hl7.org/fhir/extensions/https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-artifact-description.html
URLhttp://hl7.org/fhir/StructureDefinition/artifact-description
Version5.3.0-ballot
Statusactive
Date2022-02-07
NameArtifactDescription
TitleArtifact Description
Realmuv
Authorityhl7
DescriptionA free text natural language description of the artifact from a consumer's perspective.
PurposeThis extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way, such as Medication. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. Note that the apparently related [Resource Name extension](StructureDefinition-resource-instance-name.html) is only used as part of the IG publication tooling process, to populate the ImplementationGuide.definition.resource.name and description. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (ConditionDefinition,DeviceDefinition,ExampleScenario,Group,ObservationDefinition,SpecimenDefinition,SubstanceDefinition,SubscriptionTopic).
TypeExtension
Kindcomplex-type

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Examples of Use for Extension

ResourceVersion
hl7.fhir.uv.crmi#current:Group/publishable-exampleR4
hl7.fhir.uv.crmi#current:Group/shareable-exampleR4
hl7.fhir.uv.crmi#current:Medication/publishable-exampleR4
hl7.fhir.uv.crmi#current:Medication/shareable-exampleR4
hl7.fhir.uv.crmi#current:MedicationKnowledge/publishable-exampleR4
hl7.fhir.uv.crmi#current:MedicationKnowledge/shareable-exampleR4
hl7.fhir.uv.crmi#current:Substance/publishable-exampleR4
hl7.fhir.uv.crmi#current:Substance/shareable-exampleR4
hl7.fhir.uv.ebm#current:ArtifactAssessment/104064R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/104192R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/104193R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/104194R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/104195R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/104196R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/171898R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179448R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179469R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179515R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179693R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179694R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179698R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/179700R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/181452R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/307449R5
hl7.fhir.uv.ebm#current:ArtifactAssessment/385882R5
hl7.fhir.uv.ebm#current:Composition/104215R5
hl7.fhir.uv.ebm#current:Composition/104383R5
hl7.fhir.uv.ebm#current:Composition/178426R5
hl7.fhir.uv.ebm#current:Composition/179465R5
hl7.fhir.uv.ebm#current:Composition/179466R5
hl7.fhir.uv.ebm#current:Composition/179467R5
hl7.fhir.uv.ebm#current:Composition/179699R5
hl7.fhir.uv.ebm#current:Composition/236537R5
hl7.fhir.uv.ebm#current:Composition/236538R5
hl7.fhir.uv.ebm#current:Composition/236951R5
hl7.fhir.uv.ebm#current:Composition/256358R5
hl7.fhir.uv.ebm#current:Composition/282931R5
hl7.fhir.uv.ebm#current:Composition/292951R5
hl7.fhir.uv.ebm#current:Composition/307245R5
hl7.fhir.uv.ebm#current:Composition/307248R5
hl7.fhir.uv.ebm#current:Composition/312172R5
hl7.fhir.uv.ebm#current:Composition/312203R5
hl7.fhir.uv.ebm#current:Composition/318262R5
hl7.fhir.uv.ebm#current:Composition/342828R5
hl7.fhir.uv.ebm#current:Composition/343007R5
hl7.fhir.uv.ebm#current:Composition/343018R5
hl7.fhir.uv.ebm#current:Composition/367880R5
hl7.fhir.uv.ebm#current:Composition/372776R5
hl7.fhir.uv.ebm#current:Composition/375280R5
hl7.fhir.uv.ebm#current:List/179470R5
hl7.fhir.uv.ebm#current:List/179579R5
hl7.fhir.uv.ebm#current:List/179585R5
hl7.fhir.uv.ebm#current:List/179800R5
hl7.fhir.uv.ebm#current:List/307202R5
hl7.fhir.uv.ebm#current:List/307246R5
hl7.fhir.uv.ebm#current:List/307247R5
hl7.fhir.uv.ebm#current:List/312201R5
hl7.fhir.uv.ebm#current:List/312205R5
hl7.fhir.uv.ebm#current:List/375184R5

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition artifact-description

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionNatural language description of the artifact
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/artifact-description"
... value[x] 1..1markdownValue of extension

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "artifact-description",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-bind"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/artifact-description",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.5.1770"
    }
  ],
  "version": "5.3.0-ballot",
  "name": "ArtifactDescription",
  "title": "Artifact Description",
  "status": "active",
  "experimental": false,
  "date": "2022-02-07",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "A free text natural language description of the artifact from a consumer's perspective.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "purpose": "This extension is defined to support representing artifact metadata on resources that are not already canonical resources that have the corresponding element, and that behave in a definitional way, such as Medication. For example, it would not be appropriate to use this extension on a patient-specific resource such as MedicationRequest or CarePlan. Note that the apparently related [Resource Name extension](StructureDefinition-resource-instance-name.html) is only used as part of the IG publication tooling process, to populate the ImplementationGuide.definition.resource.name and description. For resources where this element was added in R5, the cross-version extension should be used rather than this extension (ConditionDefinition,DeviceDefinition,ExampleScenario,Group,ObservationDefinition,SpecimenDefinition,SubstanceDefinition,SubscriptionTopic).",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "ArtifactAssessment"
    },
    {
      "type": "element",
      "expression": "ClinicalUseDefinition"
    },
    {
      "type": "element",
      "expression": "ConditionDefinition"
    },
    {
      "type": "element",
      "expression": "DeviceDefinition"
    },
    {
      "type": "element",
      "expression": "ExampleScenario"
    },
    {
      "type": "element",
      "expression": "Group"
    },
    {
      "type": "element",
      "expression": "Medication"
    },
    {
      "type": "element",
      "expression": "MedicationKnowledge"
    },
    {
      "type": "element",
      "expression": "ObservationDefinition"
    },
    {
      "type": "element",
      "expression": "SpecimenDefinition"
    },
    {
      "type": "element",
      "expression": "SubstanceDefinition"
    },
    {
      "type": "element",
      "expression": "SubscriptionTopic"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Natural language description of the artifact",
        "definition": "A free text natural language description of the artifact from a consumer's perspective.",
        "comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "id"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-description",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Value of extension",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "markdown"
          }
        ],
        "condition": [
          "ext-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Natural language description of the artifact",
        "definition": "A free text natural language description of the artifact from a consumer's perspective.",
        "comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/artifact-description"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "markdown"
          }
        ]
      }
    ]
  }
}